常用的C/C++工程Makefile模板

布满荆棘的人生 2022-08-06 09:12 195阅读 0赞

在Linux下做开发难免要接触makefile，整个项目的构建都依赖于它。100个developer有100种makefile的写法，在一个较大的项目中，各种各样的makefile无论在开发、后期维护还是整个系统的持续集成都是一个负担。  
  
  
  
有幸参与重构一个遗留系统的makefile，以下是一些心得和一个makefile模板。  
重构目的：  
1.清晰易懂、容易维护  
2.方便系统的持续集成  
重构原则：  
1.子模块makefile模板化  
2.外部依赖、通用宏定义集中化  
3.中间和最终输出集中，便于系统构建  
  
  
  
下面是总结出的一个makefile模板，我在日常的开发中都用它，其中加入了详细的注释。  
  
  
  
view plaincopy to clipboardprint?  
\#Get the ROOT\_PATH which common files located, assuming this makefile located in $(ROOT\_PATH)/src/sub\_module  
ROOT\_PATH = $(shell cd ../..; pwd)  
  
\#Where define the path of third party modules  
include $(ROOT\_PATH)/path  
  
\#Where define common macros such as CC=gcc, CXX=g++ and so on  
include $(ROOT\_PATH)/common  
  
\#Set target output path and the path of intermidiate object  
\#The path macros should include in $(ROOT\_PATH)/path  
OUT\_PATH = $(OUTPUT\_PATH)/submodule  
OBJ\_PATH = $(TMPOBJ\_PATH)/submodule  
TARGET = $(OUT\_PATH)/targe  
  
\#If the targe is share object then set corresponding flags  
\#which should define in $(ROOT\_PATH)/common  
CFLAGS += $(CFLAGS\_SO)  
LDFLAGS += $(LDFLAGS\_SO)  
\#Custom Predefines  
CFLAGS += -DXXXXXXXX  
CFLAGS += -DYYYYYYYY  
\#Dependent header files  
\#The path macros should include in $(ROOT\_PATH)/path  
CFLAGS += -I. /  
\-I$(XXXX\_INC) /  
\-I$(YYYY\_INC) /  
\-I$(ZZZZ\_INC)  
\#Dependent libraries  
\#The path macros should include in $(ROOT\_PATH)/path  
LDFLAGS += -L$(XXXX\_LIB) -lxxxx /  
\-L$(YYYY\_LIB) -lyyyy  
  
\#Set CPP source directory  
CPP\_SRCDIR = .  
\#Or set specific CPP Source files  
ADDITIONAL\_CPP\_SOURCES = /  
$(PATH\_A)/a.cpp /  
$(PATH\_B)/b.cpp  
  
\#Traverse every directory in $(CPP\_SRCDIR), and find every cpp file  
CPP\_SOURCES = $(foreach d,$(CPP\_SRCDIR),$(wildcard $(d)/\*.cpp) ) $(ADDITIONAL\_CPP\_SOURCES)  
\#Traverse every cpp file in $(CPP\_SOURCES) and get corresponding object file(.o)  
CPP\_OBJFILES = $(patsubst %.cpp,$(OBJ\_PATH)/%.o,$(notdir $(CPP\_SOURCES)))  
  
\#Set C source directory  
C\_SRCDIR =  
\#Or set specific C Source files  
ADDITIONAL\_C\_SOURCES = /  
$(PATH\_A)/a.c /  
$(PATH\_B)/b.c  
  
\#C Source files  
C\_SOURCES = $(foreach d,$(C\_SRCDIR),$(wildcard $(d)/\*.c) ) $(ADDITIONAL\_C\_SOURCES)  
C\_OBJFILES = $(patsubst %.c,$(OBJ\_PATH)/%.o,$(notdir $(C\_SOURCES)))  
  
\#Set vpath where to find these types of files  
vpath %.cpp $(dir $(CPP\_SOURCES))  
vpath %.c $(dir $(C\_SOURCES))  
vpath %.o $(OBJ\_PATH)  
  
\#The first target to be executed  
all: target  
  
target: $(TARGET)  
  
\#Static dependecy pattern  
\#$(OBJ\_PATH)/%.o define the pattern of target and %.c or %.cpp is the final dependency  
$(C\_OBJFILES): $(OBJ\_PATH)/%.o: %.c  
\-mkdir -p $(OBJ\_PATH)  
$(CXX) -c $(CFLAGS) -o $@ $<  
  
$(CPP\_OBJFILES): $(OBJ\_PATH)/%.o: %.cpp  
\-mkdir -p $(OBJ\_PATH)  
$(CXX) -c $(CFLAGS) -o $@ $<  
  
$(TARGET): $(CPP\_OBJFILES) $(C\_OBJFILES)  
\-mkdir -p $(OUT\_PATH)  
$(CXX) -o $@ $^ $(LDFLAGS)  
  
clean:  
\-rm -rf $(OBJ\_PATH)  
\-rm -f $(TARGET)  
\#Get the ROOT\_PATH which common files located, assuming this makefile located in $(ROOT\_PATH)/src/sub\_module  
ROOT\_PATH = $(shell cd ../..; pwd)  
  
\#Where define the path of third party modules  
include $(ROOT\_PATH)/path  
  
\#Where define common macros such as CC=gcc, CXX=g++ and so on  
include $(ROOT\_PATH)/common  
  
\#Set target output path and the path of intermidiate object  
\#The path macros should include in $(ROOT\_PATH)/path  
OUT\_PATH = $(OUTPUT\_PATH)/submodule  
OBJ\_PATH = $(TMPOBJ\_PATH)/submodule  
TARGET = $(OUT\_PATH)/targe  
  
\#If the targe is share object then set corresponding flags  
\#which should define in $(ROOT\_PATH)/common  
CFLAGS += $(CFLAGS\_SO)  
LDFLAGS += $(LDFLAGS\_SO)  
\#Custom Predefines  
CFLAGS += -DXXXXXXXX  
CFLAGS += -DYYYYYYYY  
\#Dependent header files  
\#The path macros should include in $(ROOT\_PATH)/path  
CFLAGS += -I. /  
\-I$(XXXX\_INC) /  
\-I$(YYYY\_INC) /  
\-I$(ZZZZ\_INC)  
\#Dependent libraries  
\#The path macros should include in $(ROOT\_PATH)/path  
LDFLAGS += -L$(XXXX\_LIB) -lxxxx /  
\-L$(YYYY\_LIB) -lyyyy  
  
\#Set CPP source directory  
CPP\_SRCDIR = .  
\#Or set specific CPP Source files  
ADDITIONAL\_CPP\_SOURCES = /  
$(PATH\_A)/a.cpp /  
$(PATH\_B)/b.cpp  
  
\#Traverse every directory in $(CPP\_SRCDIR), and find every cpp file  
CPP\_SOURCES = $(foreach d,$(CPP\_SRCDIR),$(wildcard $(d)/\*.cpp) ) $(ADDITIONAL\_CPP\_SOURCES)  
\#Traverse every cpp file in $(CPP\_SOURCES) and get corresponding object file(.o)

CPP\_OBJFILES = $(patsubst %.cpp,$(OBJ\_PATH)/%.o,$(notdir $(CPP\_SOURCES)))  
  
\#Set C source directory  
C\_SRCDIR =  
\#Or set specific C Source files  
ADDITIONAL\_C\_SOURCES = /  
$(PATH\_A)/a.c /  
$(PATH\_B)/b.c  
  
\#C Source files  
C\_SOURCES = $(foreach d,$(C\_SRCDIR),$(wildcard $(d)/\*.c) ) $(ADDITIONAL\_C\_SOURCES)  
C\_OBJFILES = $(patsubst %.c,$(OBJ\_PATH)/%.o,$(notdir $(C\_SOURCES)))  
  
\#Set vpath where to find these types of files  
vpath %.cpp $(dir $(CPP\_SOURCES))  
vpath %.c $(dir $(C\_SOURCES))  
vpath %.o $(OBJ\_PATH)  
  
\#The first target to be executed  
all: target  
  
target: $(TARGET)  
  
\#Static dependecy pattern  
\#$(OBJ\_PATH)/%.o define the pattern of target and %.c or %.cpp is the final dependency  
$(C\_OBJFILES): $(OBJ\_PATH)/%.o: %.c  
\-mkdir -p $(OBJ\_PATH)  
$(CXX) -c $(CFLAGS) -o $@ $<  
  
$(CPP\_OBJFILES): $(OBJ\_PATH)/%.o: %.cpp  
\-mkdir -p $(OBJ\_PATH)  
$(CXX) -c $(CFLAGS) -o $@ $<  
  
$(TARGET): $(CPP\_OBJFILES) $(C\_OBJFILES)  
\-mkdir -p $(OUT\_PATH)  
$(CXX) -o $@ $^ $(LDFLAGS)  
  
clean:  
\-rm -rf $(OBJ\_PATH)  
\-rm -f $(TARGET)