`
xitong
  • 浏览: 6197765 次
文章分类
社区版块
存档分类
最新评论

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 的内容如下:
  1. ###############################################################################
  2. #
  3. #GenericMakefileforC/C++Program
  4. #
  5. #Author:whyglinux(whyglinuxAThotmailDOTcom)
  6. #Date:2006/03/04
  7. #Description:
  8. #Themakefilesearchesin<SRCDIRS>directoriesforthesourcefiles
  9. #withextensionsspecifiedin<SOURCE_EXT>,thencompilesthesources
  10. #andfinallyproducesthe<PROGRAM>,theexecutablefile,bylinking
  11. #theobjectives.
  12. #Usage:
  13. #$makecompileandlinktheprogram.
  14. #$makeobjscompileonly(nolinking.Rarelyused).
  15. #$makecleancleantheobjectivesanddependencies.
  16. #$makecleanallcleantheobjectives,dependenciesandexecutable.
  17. #$makerebuildrebuildtheprogram.Thesameasmakeclean&&makeall.
  18. #==============================================================================
  19. ##CustomizingSection:adjustthefollowingifnecessary.
  20. ##=============================================================================
  21. #Theexecutablefilename.
  22. #Itmustbespecified.
  23. #PROGRAM:=a.out#theexecutablename
  24. PROGRAM:=
  25. #Thedirectoriesinwhichsourcefilesreside.
  26. #Atleastonepathshouldbespecified.
  27. #SRCDIRS:=.#currentdirectory
  28. SRCDIRS:=
  29. #Thesourcefiletypes(headersexcluded).
  30. #Atleastonetypeshouldbespecified.
  31. #Thevalidsuffixesareamongof.c,.C,.cc,.cpp,.CPP,.c++,.cp,or.cxx.
  32. #SRCEXTS:=.c#Cprogram
  33. #SRCEXTS:=.cpp#C++program
  34. #SRCEXTS:=.c.cpp#C/C++program
  35. SRCEXTS:=
  36. #Theflagsusedbythecpp(mancppformore).
  37. #CPPFLAGS:=-Wall-Werror#showallwarningsandtakethemaserrors
  38. CPPFLAGS:=
  39. #ThecompilingflagsusedonlyforC.
  40. #IfitisaC++program,noneedtosettheseflags.
  41. #IfitisaCandC++mergingprogram,settheseflagsfortheCparts.
  42. CFLAGS:=
  43. CFLAGS+=
  44. #ThecompilingflagsusedonlyforC++.
  45. #IfitisaCprogram,noneedtosettheseflags.
  46. #IfitisaCandC++mergingprogram,settheseflagsfortheC++parts.
  47. CXXFLAGS:=
  48. CXXFLAGS+=
  49. #Thelibraryandthelinkoptions(CandC++common).
  50. LDFLAGS:=
  51. LDFLAGS+=
  52. ##ImplictSection:changethefollowingonlywhennecessary.
  53. ##=============================================================================
  54. #TheCprogramcompiler.Uncommentittospecifyyoursexplicitly.
  55. #CC=gcc
  56. #TheC++programcompiler.Uncommentittospecifyyoursexplicitly.
  57. #CXX=g++
  58. #Uncommentthe2linestocompileCprogramsasC++ones.
  59. #CC=$(CXX)
  60. #CFLAGS=$(CXXFLAGS)
  61. #Thecommandusedtodeletefile.
  62. #RM=rm-f
  63. ##StableSection:usuallynoneedtobechanged.Butyoucanaddmore.
  64. ##=============================================================================
  65. SHELL=/bin/sh
  66. SOURCES=$(foreachd,$(SRCDIRS),$(wildcard$(addprefix$(d)/*,$(SRCEXTS))))
  67. OBJS=$(foreachx,$(SRCEXTS),/
  68. $(patsubst%$(x),%.o,$(filter%$(x),$(SOURCES))))
  69. DEPS=$(patsubst%.o,%.d,$(OBJS))
  70. .PHONY:allobjscleancleanallrebuild
  71. all:$(PROGRAM)
  72. #Rulesforcreatingthedependencyfiles(.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. #Rulesforproducingtheobjects.
  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. #Rulesforproducingtheexecutable.
  110. #----------------------------------------------
  111. $(PROGRAM):$(OBJS)
  112. ifeq($(strip$(SRCEXTS)),.c)#Cfile
  113. $(CC)-o$(PROGRAM)$(OBJS)$(LDFLAGS)
  114. else#C++file
  115. $(CXX)-o$(PROGRAM)$(OBJS)$(LDFLAGS)
  116. endif
  117. -include$(DEPS)
  118. rebuild:cleanall
  119. clean:
  120. @$(RM)*.o*.d
  121. cleanall:clean
  122. @$(RM)$(PROGRAM)$(PROGRAM).exe
  123. ###EndoftheMakefile##Suggestionsarewelcome##Allrightsreserved###
  124. ###############################################################################


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

例一 Hello World 程序

这个程序的功能是输出 Hello, world! 这样一行文字。由 hello.h、hello.c、main.cxx 三个文件组成。前两个文件是 C 程序,后一个是 C++ 程序,因此这是一个 C 和 C++ 混编程序。
  1. /*Filename:hello.h
  2. *Cheaderfile
  3. */
  4. #ifndefHELLO_H
  5. #defineHELLO_H
  6. #ifdef__cplusplus
  7. extern"C"{
  8. #endif
  9. voidprint_hello();
  10. #ifdef__cplusplus
  11. }
  12. #endif
  13. #endif

  1. /*Filename:hello.c
  2. *Csourcefile.
  3. */
  4. #include"hello.h"
  5. #include<stdio.h>
  6. voidprint_hello()
  7. {
  8. puts("Hello,world!");
  9. }

  1. /*Filename:main.cxx
  2. *C++sourcefile.
  3. */
  4. #include"hello.h"
  5. intmain()
  6. {
  7. print_hello();
  8. return0;
  9. }


建立一个新的目录,然后把这三个文件拷贝到目录中,也把 Makefile 文件拷贝到目录中。之后,对 Makefile 的相关项目进行如下设置:
  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 做如下设置:
  1. PROGRAM:=hello#设置运行程序名
  2. SRCDIRS:=.#源程序位于当前目录下
  3. SRCEXTS:=.c#源程序文件只有.c一种类型
  4. CFLAGS:=`pkg-config--cflagsgtk+-2.0`#CFLAGS
  5. LDFLAGS:=`pkg-config--libsgtk+-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/

分享到:
评论

相关推荐

    通用Makefile,适用于C/C++混合编程

    包含两个通用的Makefile,原理比较类似,适用于.c、.cpp、.cc的C/C++混合编程,当然也适用于只有一种语言的工程,用户可以根据各自的工程目录,稍加修改便可使用。

    通用c/c++ makefile例子

    Generic Makefile for C/C++ Program 通用的c/c++ makefile例子,可以自定义文件夹和lib库

    Makefile C/C++项目编译

    C/C++通用makefile,可以用来编译C或者C++项目,只需要修改部分值。 可以编译递归子目录的源文件。。。可以进行多目录编译。。。

    万能通用性Makefile/C++/C全自动编译实例

    Makefile编写实例: 1.前提是需要安装MInGw——c/c++编译器,不懂的可以私信我哈; 2.本程序是利用bat脚本直接运行...3.makefile为采用通用性规则编写,自动搜索所在目录中的代码,自动编译; 4.适应于编译C++/C代码。

    linux C与C++混合编程通用makefile

    支持Linux 下 C与C++混合编程的makefile 。

    CC++ 通用 Makefile

    本文提供了一个用于对 C/C++ 程序进行编译和连接以产生可执行程序的通用 Makefile。 在使用 Makefile 之前,只需对它进行一些简单的设置即可;而且一经设置,即使以后对源程序文件有所增减一般也不再需要改动 ...

    Makefile万能通用版(C++和C混合编译也适用)

    通用版,Makefile C++和c混合编译

    eclipse 开发c/c++

    C 和 C++ 语言都是世界上最流行且使用最普遍的编程语言, 因此 Eclipse 平台(Eclipse Platform)提供对 C/C++ 开发的支持一点都不足为奇。 因为 Eclipse 平台只是用于开发者工具的一个框架,它不直接支持 C/C++;它...

    My_General_Makefile.zip_Linux/Unix编程_C/C++_

    这是一个Unix/Linux下基于GNU Make环境编写的一个C/C++通用Makefile

    C++ 通用MakeFile

    本文提供了一个用于对 C/C++ 程序进行编译和连接以产生可执行程序的通用 Makefile。 在 使用 Makefile 之前,只需对它进行一些简单的设置即可;而且一经设置,即使以后对源程序文件有所增减一般也不再需要改动 ...

    C、C++_通用Makefile1

    因此,即便是一个没有学习过 Makefile 书写规则的人,也可以为自己的 C/C++ 程序快速建立一个可工作的 Makefile。此 Makefile 的使用

    C语言C++通用自定义log打印函数

    log打印函数,功能如下: 1 可控制宏DEBUG决定log,输出...2 宏LOG_TAG输出log所在的模块,可将此宏放到makefile中或.h中或.cpp赋值, 3 输出log等级,所在模块信息,所在行数,所在函数,及可添加的任意参数及信息

    makefile模板

    用于C/C++的通用Makefile模板

    简洁通用makefile

    万能Makefile,通用makefile,简洁makefile 功能: (1)自动搜索编译指定目录下的所有c/c++程序文件 (2)自动搜索并包含(#include)指定目录下的头文件 (3) 可一次性生成多个可执行文件 (4) 设置简单 希望能...

    通用的makefile模板

    本文提供了一个用于对 C/C++ 程序进行编译和连接以产生可执行程序的通用 Makefile。 在使用 Makefile 之前,只需对它进行一些简单的设置即可;而且一经设置,即使以后对源程序文件有所增减一般也不再需要改动 ...

    Makefile模板文件

    本文提供了一个用于对 C/C++ 程序进行编译和连接以产生可执行程序的通用 Makefile。 在使用 Makefile 之前,只需对它进行一些简单的设置即可;而且一经设置,即使以后对源程序文件有所增减一般也不再需要改动 ...

    简单通用Makefile使用示例工程

    简单的能够编译C和C++工程,以及C与C++混合工程, ,有一些基础的makefile, 供大家一起学习交流,不知道怎么编程了需要41积分。。。

    万能Makefile

    编译C/C++源码的万能Makefile

    C++关于Makefile的详解含通用模板

    Makefile是一个规定了怎么去编译和链接程序的脚本文件,在执行make命令时会执行该文件,window环境下的IDE,如visual studio已经集成了该功能,不需要关心程序的编译规则,在linux下做C/C++开发时经常用到,说到这里...

    通用makefile文件

    通用makefile文件,可将此文件和所需要编译的C/CPP文件放在一个文件夹中,此make文件会自动搜索此目录内的所有文件进行编译,使用简单方便。内部全部使用宏的方式,方便进行扩展修改。

Global site tag (gtag.js) - Google Analytics