向大家推荐一个C/C++通用Makefile

Posted 追忆丶年华

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了向大家推荐一个C/C++通用Makefile相关的知识,希望对你有一定的参考价值。

在使用 Makefile 之前,只需对它进行一些简单的设置即可;而且一经设置,即使以后对源程序文件有所增减一般也不再需要改动 Makefile。因此,即便是一个没有学习过 Makefile 书写规则的人,也可以为自己的 C/C++ 程序快速建立一个可工作的 Makefile。 

这个 Makefile 可以在 GNU Make 和 GCC 编译器下正常工作。但是不能保证对于其它版本的 Make 和编译器也能正常工作。

此 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 的内容如下: 

C代码  技术分享图片
  1. #############################################################  
  2. # Generic Makefile for C/C++ Program  
  3. #  
  4. # License: GPL (General Public License)  
  5. # Author:  whyglinux <whyglinux AT gmail DOT com>  
  6. # Date:    2006/03/04 (version 0.1)  
  7. #          2007/03/24 (version 0.2)  
  8. #          2007/04/09 (version 0.3)  
  9. #          2007/06/26 (version 0.4)  
  10. #          2008/04/05 (version 0.5)  
  11. #  
  12. # Description:  
  13. # ------------  
  14. # This is an easily customizable makefile template. The purpose is to  
  15. # provide an instant building environment for C/C++ programs.  
  16. #  
  17. # It searches all the C/C++ source files in the specified directories,  
  18. # makes dependencies, compiles and links to form an executable.  
  19. #  
  20. # Besides its default ability to build C/C++ programs which use only  
  21. # standard C/C++ libraries, you can customize the Makefile to build  
  22. # those using other libraries. Once done, without any changes you can  
  23. # then build programs using the same or less libraries, even if source  
  24. # files are renamed, added or removed. Therefore, it is particularly  
  25. # convenient to use it to build codes for experimental or study use.  
  26. #  
  27. # GNU make is expected to use the Makefile. Other versions of makes  
  28. # may or may not work.  
  29. #  
  30. # Usage:  
  31. # ------  
  32. # 1. Copy the Makefile to your program directory.  
  33. # 2. Customize in the "Customizable Section" only if necessary:  
  34. #    * to use non-standard C/C++ libraries, set pre-processor or compiler  
  35. #      options to <MY_CFLAGS> and linker ones to <MY_LIBS>  
  36. #      (See Makefile.gtk+-2.0 for an example)  
  37. #    * to search sources in more directories, set to <SRCDIRS>  
  38. #    * to specify your favorite program name, set to <PROGRAM>  
  39. # 3. Type make to start building your program.  
  40. #  
  41. # Make Target:  
  42. # ------------  
  43. # The Makefile provides the following targets to make:  
  44. #   $ make           compile and link  
  45. #   $ make NODEP=yes compile and link without generating dependencies  
  46. #   $ make objs      compile only (no linking)  
  47. #   $ make tags      create tags for Emacs editor  
  48. #   $ make ctags     create ctags for VI editor  
  49. #   $ make clean     clean objects and the executable file  
  50. #   $ make distclean clean objects, the executable and dependencies  
  51. #   $ make help      get the usage of the makefile  
  52. #  
  53. #===========================================================================  
  54.   
  55. ## Customizable Section: adapt those variables to suit your program.  
  56. ##==========================================================================  
  57.   
  58. # The pre-processor and compiler options.  
  59. MY_CFLAGS =  
  60.   
  61. # The linker options.  
  62. MY_LIBS   =  
  63.   
  64. # The pre-processor options used by the cpp (man cpp for more).  
  65. CPPFLAGS  = -Wall  
  66.   
  67. # The options used in linking as well as in any direct use of ld.  
  68. LDFLAGS   =  
  69.   
  70. # The directories in which source files reside.  
  71. # If not specified, only the current directory will be serached.  
  72. SRCDIRS   =  
  73.   
  74. # The executable file name.  
  75. # If not specified, current directory name or `a.out‘ will be used.  
  76. PROGRAM   =  
  77.   
  78. ## Implicit Section: change the following only when necessary.  
  79. ##==========================================================================  
  80.   
  81. # The source file types (headers excluded).  
  82. # .c indicates C source files, and others C++ ones.  
  83. SRCEXTS = .c .C .cc .cpp .CPP .c++ .cxx .cp  
  84.   
  85. # The header file types.  
  86. HDREXTS = .h .H .hh .hpp .HPP .h++ .hxx .hp  
  87.   
  88. # The pre-processor and compiler options.  
  89. # Users can override those variables from the command line.  
  90. CFLAGS  = -g -O2  
  91. CXXFLAGS= -g -O2  
  92.   
  93. # The C program compiler.  
  94. #CC     = gcc  
  95.   
  96. # The C++ program compiler.  
  97. #CXX    = g++  
  98.   
  99. # Un-comment the following line to compile C programs as C++ ones.  
  100. #CC     = $(CXX)  
  101.   
  102. # The command used to delete file.  
  103. #RM     = rm -f  
  104.   
  105. ETAGS = etags  
  106. ETAGSFLAGS =  
  107.   
  108. CTAGS = ctags  
  109. CTAGSFLAGS =  
  110.   
  111. ## Stable Section: usually no need to be changed. But you can add more.  
  112. ##==========================================================================  
  113. SHELL   = /bin/sh  
  114. EMPTY   =  
  115. SPACE   = $(EMPTY) $(EMPTY)  
  116. ifeq ($(PROGRAM),)  
  117.   CUR_PATH_NAMES = $(subst /,$(SPACE),$(subst $(SPACE),_,$(CURDIR)))  
  118.   PROGRAM = $(word $(words $(CUR_PATH_NAMES)),$(CUR_PATH_NAMES))  
  119.   ifeq ($(PROGRAM),)  
  120.     PROGRAM = a.out  
  121.   endif  
  122. endif  
  123. ifeq ($(SRCDIRS),)  
  124.   SRCDIRS = .  
  125. endif  
  126. SOURCES = $(foreach d,$(SRCDIRS),$(wildcard $(addprefix $(d)/*,$(SRCEXTS))))  
  127. HEADERS = $(foreach d,$(SRCDIRS),$(wildcard $(addprefix $(d)/*,$(HDREXTS))))  
  128. SRC_CXX = $(filter-out %.c,$(SOURCES))  
  129. OBJS    = $(addsuffix .o, $(basename $(SOURCES)))  
  130. DEPS    = $(OBJS:.o=.d)  
  131.   
  132. ## Define some useful variables.  
  133. DEP_OPT = $(shell if `$(CC) --version | grep "GCC" >/dev/null`; then \  
  134.                   echo "-MM -MP"; else echo "-M"; fi )  
  135. DEPEND      = $(CC)  $(DEP_OPT)  $(MY_CFLAGS) $(CFLAGS) $(CPPFLAGS)  
  136. DEPEND.d    = $(subst -g ,,$(DEPEND))  
  137. COMPILE.c   = $(CC)  $(MY_CFLAGS) $(CFLAGS)   $(CPPFLAGS) -c  
  138. COMPILE.cxx = $(CXX) $(MY_CFLAGS) $(CXXFLAGS) $(CPPFLAGS) -c  
  139. LINK.c      = $(CC)  $(MY_CFLAGS) $(CFLAGS)   $(CPPFLAGS) $(LDFLAGS)  
  140. LINK.cxx    = $(CXX) $(MY_CFLAGS) $(CXXFLAGS) $(CPPFLAGS) $(LDFLAGS)  
  141.   
  142. .PHONY: all objs tags ctags clean distclean help show  
  143.   
  144. # Delete the default suffixes  
  145. .SUFFIXES:  
  146.   
  147. all: $(PROGRAM)  
  148.   
  149. # Rules for creating dependency files (.d).  
  150. #------------------------------------------  
  151.   
  152. %.d:%.c  
  153.     @echo -n $(dir $<) > [email protected]  
  154.     @$(DEPEND.d) $< >> [email protected]  
  155.   
  156. %.d:%.C  
  157.     @echo -n $(dir $<) > [email protected]  
  158.     @$(DEPEND.d) $< >> [email protected]  
  159.   
  160. %.d:%.cc  
  161.     @echo -n $(dir $<) > [email protected]  
  162.     @$(DEPEND.d) $< >> [email protected]  
  163.   
  164. %.d:%.cpp  
  165.     @echo -n $(dir $<) > [email protected]  
  166.     @$(DEPEND.d) $< >> [email protected]  
  167.   
  168. %.d:%.CPP  
  169.     @echo -n $(dir $<) > [email protected]  
  170.     @$(DEPEND.d) $< >> [email protected]  
  171.   
  172. %.d:%.c++  
  173.     @echo -n $(dir $<) > [email protected]  
  174.     @$(DEPEND.d) $< >> [email protected]  
  175.   
  176. %.d:%.cp  
  177.     @echo -n $(dir $<) > [email protected]  
  178.     @$(DEPEND.d) $< >> [email protected]  
  179.   
  180. %.d:%.cxx  
  181.     @echo -n $(dir $<) > [email protected]  
  182.     @$(DEPEND.d) $< >> [email protected]  
  183.   
  184. # Rules for generating object files (.o).  
  185. #----------------------------------------  
  186. objs:$(OBJS)  
  187.   
  188. %.o:%.c  
  189.     $(COMPILE.c) $< -o [email protected]  
  190.   
  191. %.o:%.C  
  192.     $(COMPILE.cxx) $< -o [email protected]  
  193.   
  194. %.o:%.cc  
  195.     $(COMPILE.cxx) $< -o [email protected]  
  196.   
  197. %.o:%.cpp  
  198.     $(COMPILE.cxx) $< -o [email protected]  
  199.   
  200. %.o:%.CPP  
  201.     $(COMPILE.cxx) $< -o [email protected]  
  202.   
  203. %.o:%.c++  
  204.     $(COMPILE.cxx) $< -o [email protected]  
  205.   
  206. %.o:%.cp  
  207.     $(COMPILE.cxx) $< -o [email protected]  
  208.   
  209. %.o:%.cxx  
  210.     $(COMPILE.cxx) $< -o [email protected]  
  211.   
  212. # Rules for generating the tags.  
  213. #-------------------------------------  
  214. tags: $(HEADERS) $(SOURCES)  
  215.     $(ETAGS) $(ETAGSFLAGS) $(HEADERS) $(SOURCES)  
  216.   
  217. ctags: $(HEADERS) $(SOURCES)  
  218.     $(CTAGS) $(CTAGSFLAGS) $(HEADERS) $(SOURCES)  
  219.   
  220. # Rules for generating the executable.  
  221. #-------------------------------------  
  222. $(PROGRAM):$(OBJS)  
  223. ifeq ($(SRC_CXX),)              # C program  
  224.     $(LINK.c)   $(OBJS) $(MY_LIBS) -o [email protected]  
  225.     @echo Type ./[email protected] to execute the program.  
  226. else                            # C++ program  
  227.     $(LINK.cxx) $(OBJS) $(MY_LIBS) -o [email protected]  
  228.     @echo Type ./[email protected] to execute the program.  
  229. endif  
  230.   
  231. ifndef NODEP  
  232. ifneq ($(DEPS),)  
  233.   sinclude $(DEPS)  
  234. endif  
  235. endif  
  236.   
  237. clean:  
  238.     $(RM) $(OBJS) $(PROGRAM) $(PROGRAM).exe  
  239.   
  240. distclean: clean  
  241.     $(RM) $(DEPS) TAGS  
  242.   
  243. # Show help.  
  244. help:  
  245.     @echo ‘Generic Makefile for C/C++ Programs (gcmakefile) version 0.5‘  
  246.     @echo ‘Copyright (C) 2007, 2008 whyglinux <[email protected]>‘  
  247.     @echo  
  248.     @echo ‘Usage: make [TARGET]‘  
  249.     @echo ‘TARGETS:‘  
  250.     @echo ‘  all       (=make) compile and link.‘  
  251.     @echo ‘  NODEP=yes make without generating dependencies.‘  
  252.     @echo ‘  objs      compile only (no linking).‘  
  253.     @echo ‘  tags      create tags for Emacs editor.‘  
  254.     @echo ‘  ctags     create ctags for VI editor.‘  
  255.     @echo ‘  clean     clean objects and the executable file.‘  
  256.     @echo ‘  distclean clean objects, the executable and dependencies.‘  
  257.     @echo ‘  show      show variables (for debug use only).‘  
  258.     @echo ‘  help      print this message.‘  
  259.     @echo  
  260.     @echo ‘Report bugs to <whyglinux AT gmail DOT com>.‘  
  261.   
  262. # Show variables (for debug use only.)  
  263. show:  
  264.     @echo ‘PROGRAM     :‘ $(PROGRAM)  
  265.     @echo ‘SRCDIRS     :‘ $(SRCDIRS)  
  266.     @echo ‘HEADERS     :‘ $(HEADERS)  
  267.     @echo ‘SOURCES     :‘ $(SOURCES)  
  268.     @echo ‘SRC_CXX     :‘ $(SRC_CXX)  
  269.     @echo ‘OBJS        :‘ $(OBJS)  
  270.     @echo ‘DEPS        :‘ $(DEPS)  
  271.     @echo ‘DEPEND      :‘ $(DEPEND)  
  272.     @echo ‘COMPILE.c   :‘ $(COMPILE.c)  
  273.     @echo ‘COMPILE.cxx :‘ $(COMPILE.cxx)  
  274.     @echo ‘link.c      :‘ $(LINK.c)  
  275.     @echo ‘link.cxx    :‘ $(LINK.cxx)  
  276.   
  277. ## End of the Makefile ##  Suggestions are welcome  ## All rights reserved ##  
  278. ##############################################################  

 

 

 

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

例一 Hello World 程序

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

C代码  技术分享图片
  1. /* File name: hello.h 
  2.  * C header file 
  3.  */  
  4.   
  5. #ifndef HELLO_H  
  6. #define HELLO_H  
  7.   
  8. #ifdef __cplusplus  
  9. extern "C" {  
  10. #endif  
  11.   
  12.   void print_hello();  
  13. #ifdef __cplusplus  
  14. }  
  15.   
  16. #endif  
  17. #endif  
  18.   
  19.   
  20. /* File name: hello.c 
  21.  * C source file. 
  22.  */  
  23.   
  24. #include "hello.h"  
  25. #include <stdio.h>  
  26.   
  27. void print_hello()  
  28. {  
  29.   puts( "Hello, world!" );  
  30. }  
  31.   
  32.   
  33. /* File name: main.cxx 
  34.  * C++ source file. 
  35.  */  
  36.   
  37. #include "hello.h"  
  38.   
  39. int main()  
  40. {  
  41.   print_hello();  
  42.   return 0;  
  43. }  

 

 

建立一个新的目录,然后把这三个文件拷贝到目录中,也把 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+ 程序了。






































以上是关于向大家推荐一个C/C++通用Makefile的主要内容,如果未能解决你的问题,请参考以下文章

C/C++经典书籍推荐

强烈推荐 | 一些高质量的 C/C++ 书籍(文末再送几本)

强烈推荐 | 一些高质量的 C/C++ 书籍(文末再送几本)

在 c\c++ 中的线程和并发中推荐一本好的编程书籍 [关闭]

向大家推荐一个免费的云服务器——阿贝云

C/C++领域的练手开源项目,小伙伴们接好